Fix RST inline literal rendering in obstacle layer docs#894
Closed
remete618 wants to merge 1 commit intoros-navigation:masterfrom
Closed
Fix RST inline literal rendering in obstacle layer docs#894remete618 wants to merge 1 commit intoros-navigation:masterfrom
remete618 wants to merge 1 commit intoros-navigation:masterfrom
Conversation
Remove double-backtick inline literal markup from RST field list names in the obstacle costmap plugin docs. The markup triggered a rendering bug in sphinx_rtd_theme, causing field names to overflow their containers.
mini-1235
reviewed
Apr 3, 2026
Collaborator
mini-1235
left a comment
mini-1235
left a comment
There was a problem hiding this comment.
Can you show us the screenshot after these changes?
Member
|
I looked over the changes and I think we should keep this as-is. This is an intentional choice for organization of plugin-based namespaced parameters. I appreciate the effort and agree its suboptimal but there's trade offs were making on that front. Hope you can contribute more in the future and sorry that we cannot accept this PR! We're currently working on some new documentation formatting, so in the coming months should be vastly improved anyway. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
What changed
configuration/packages/costmap-plugins/obstacle.rst: replaced 22 field name entries from:to:
The double-backtick markup inside field list names triggers a rendering bug in sphinx_rtd_theme (ref: sphinx_rtd_theme #1678), causing field names to overflow their containers. Plain-text angle brackets are sufficient here.
Test plan